home *** CD-ROM | disk | FTP | other *** search
/ Visual Cafe 3 / Visual Cafe 3.ISO / Vcafe / JFC.bin / TextUI.java < prev    next >
Text File  |  1998-06-30  |  3KB  |  96 lines
  1. /*
  2.  * @(#)TextUI.java    1.19 98/04/09
  3.  * 
  4.  * Copyright (c) 1997 Sun Microsystems, Inc. All Rights Reserved.
  5.  * 
  6.  * This software is the confidential and proprietary information of Sun
  7.  * Microsystems, Inc. ("Confidential Information").  You shall not
  8.  * disclose such Confidential Information and shall use it only in
  9.  * accordance with the terms of the license agreement you entered into
  10.  * with Sun.
  11.  * 
  12.  * SUN MAKES NO REPRESENTATIONS OR WARRANTIES ABOUT THE SUITABILITY OF THE
  13.  * SOFTWARE, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  14.  * IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
  15.  * PURPOSE, OR NON-INFRINGEMENT. SUN SHALL NOT BE LIABLE FOR ANY DAMAGES
  16.  * SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR DISTRIBUTING
  17.  * THIS SOFTWARE OR ITS DERIVATIVES.
  18.  * 
  19.  */
  20. package com.sun.java.swing.plaf;
  21.  
  22. import com.sun.java.swing.Action;
  23. import com.sun.java.swing.BoundedRangeModel;
  24. import java.awt.Point;
  25. import java.awt.Rectangle;
  26. import java.awt.Insets;
  27. import com.sun.java.swing.text.*;
  28.  
  29. /**
  30.  * Text editor user interface
  31.  *
  32.  * @author  Timothy Prinzing
  33.  * @version 1.19 04/09/98
  34.  */
  35. public abstract class TextUI extends ComponentUI
  36. {
  37.     /**
  38.      * Converts the given location in the model to a place in
  39.      * the view coordinate system.
  40.      *
  41.      * @param pos  the local location in the model to translate >= 0
  42.      * @return the coordinates as a rectangle
  43.      * @exception BadLocationException  if the given position does not
  44.      *   represent a valid location in the associated document
  45.      */
  46.     public abstract Rectangle modelToView(int pos) throws BadLocationException;
  47.  
  48.     /**
  49.      * Converts the given place in the view coordinate system
  50.      * to the nearest representative location in the model.
  51.      *
  52.      * @param pt  the location in the view to translate.  This
  53.      *   should be in the same coordinate system as the mouse
  54.      *   events.
  55.      * @returns the offset from the start of the document >= 0
  56.      */
  57.     public abstract int viewToModel(Point pt);
  58.  
  59.     /**
  60.      * Causes the portion of the view responsible for the 
  61.      * given part of the model to be repainted.
  62.      *
  63.      * @param p0 the beginning of the range >= 0
  64.      * @param p1 the end of the range >= p0
  65.      */
  66.     public abstract void damageRange(int p0, int p1);
  67.  
  68.     /**
  69.      * Fetches the binding of services that set a policy
  70.      * for the type of document being edited.  This contains
  71.      * things like the commands available, stream readers and
  72.      * writers, etc.
  73.      *
  74.      * @return the editor kit binding
  75.      */
  76.     public abstract EditorKit getEditorKit();
  77.  
  78.     /**
  79.      * Fetches a View with the allocation of the associated 
  80.      * text component (i.e. the root of the hierarchy) that 
  81.      * can be traversed to determine how the model is being
  82.      * represented spatially.
  83.      *
  84.      * @return the view
  85.      */
  86.     public abstract View getRootView();
  87.  
  88.     /**
  89.      * Fetches the default margin space for the text ui.
  90.      *
  91.      * @return the margins
  92.      */
  93.     public abstract Insets getDefaultMargin();
  94.  
  95. }
  96.